@patternfly/pfe-button

PatternFly Elements Button

<pfe-button> is a web component wrapper around a standard HTML <button> element. <pfe-button> is heavily influenced by the findings in this post: Custom elements, shadow DOM and implicit form submission. You can expect <pfe-button> to work like a normal HTMLButtonElement.

Read more about Button in the PatternFly Elements Button documentation

Installation

Load <pfe-button> via CDN:

<script src="https://unpkg.com/@patternfly/pfe-button?module"></script>

Or, if you are using NPM, install it

npm install @patternfly/pfe-button

Then once installed, import it to your application:

import '@patternfly/pfe-button';

Usage

When using this component, you must provide a standard HTML Button Elements as the only light DOM child of pfe-button.

<pfe-button>My Button</pfe-button>

Accessibility

<pfe-button> addresses the issues associated with typical implementations of web component buttons. When using a <pfe-button> in a <form> element, the <pfe-button> will function as a standard button in a <form>. You can expect the button to submit the form.

Disabled Attribute

Adding the disabled attribute to either the <pfe-button> wrapper or the <button> element in the light DOM will disable the button.

<pfe-button disabled>Submit</pfe-button>

Type Attribute

Using the type attribute works in the same fashion as the disabled attribute. You can add a type attribute to the <pfe-button> element.

<pfe-button type="button">Submit</pfe-button>
<pfe-button type="submit">Submit</pfe-button>
<pfe-button type="reset">Reset</pfe-button>